flow box: Document incompatible configurations
authorMatthias Clasen <mclasen@redhat.com>
Tue, 25 Aug 2015 17:58:40 +0000 (13:58 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Tue, 25 Aug 2015 19:54:58 +0000 (15:54 -0400)
Explain in the docs that using a model is incompatible with
using filter or sort functions.

gtk/gtkflowbox.c

index 6b6611e13fc2d901520b16111e6d45c3e322402c..c19130e6af1a22e7f3e670f55ae9e4b17083afcf 100644 (file)
@@ -4287,6 +4287,10 @@ gtk_flow_box_check_model_compat (GtkFlowBox *box)
  * gtk_flow_box_insert() or gtk_container_add()) while @box is bound to a
  * model.
  *
+ * Note that using a model is incompatible with the filtering and sorting
+ * functionality in GtkFlowBox. When using a model, filtering and sorting
+ * should be implemented by the model.
+ *
  * Since: 3.18
  */
 void
@@ -4853,6 +4857,9 @@ gtk_flow_box_get_selection_mode (GtkFlowBox *box)
  * gtk_flow_box_child_changed()) or when gtk_flow_box_invalidate_filter()
  * is called.
  *
+ * Note that using a filter function is incompatible with using a model
+ * (see gtk_flow_box_bind_model()).
+ *
  * Since: 3.12
  */
 void
@@ -4935,6 +4942,9 @@ gtk_flow_box_invalidate_filter (GtkFlowBox *box)
  * gtk_flow_box_child_changed()) and when gtk_flow_box_invalidate_sort()
  * is called.
  *
+ * + * Note that using a sort function is incompatible with using a model
+ * + * (see gtk_list_box_bind_model()).
+ *
  * Since: 3.12
  */
 void